home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / wcht214.zip / WILDCHAT.DOC < prev    next >
Text File  |  1992-12-21  |  18KB  |  504 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.              ┬┬ ┬ ┬ ┬┬ ┬┬─   ─┬┬──┐ ┌┬──┐ ┬┬  ┬ ┌┬──┐ ┌─┬┬─┐ (tm)
  18.              ││ │ │ ││ ││     ││  │ ││    ││  │ ││  │   ││
  19.              ││ │ │ ││ ││     ││  │ ││    │├──┤ │├──┤   ││
  20.              ││ │ │ ││ ││     ││  │ ││    ││  │ ││  │   ││
  21.              └┴─┴─┘ ┴┴ ┴┴──┘ ─┴┴──┘ └┴──┘ ┴┴  ┴ ┴┴  ┴   ┴┴
  22.  
  23.  
  24.                               Version 2.14
  25.  
  26.  
  27.  
  28.  
  29.                                Tim Rider
  30.                              4129 Konya Dr.
  31.                            Torrance, CA 90503
  32.  
  33.                              (310) 371-1019
  34.  
  35.         Limited voice support availible due to time constraints.
  36.  
  37.  
  38.                      The Source BBS (310) 371-3737
  39.  
  40.  
  41.  
  42.  
  43.        WildChat(tm) is supplied as is.  The author disclaims all
  44.           warranties, expressed or implied, including, without
  45.           limitation, the warranties of merchantability and of
  46.             fitness for any purpose.  The author assumes no
  47.             liability for damages, direct or consequential,
  48.           which may result from the use, or inability to use,
  49.                              WildChat(tm).
  50.  
  51.  
  52.                      (C) Copyright 1992,  Tim Rider
  53.  
  54.  
  55. What is WildChat(tm)?
  56. ═════════════════════
  57.  
  58.   WildChat is a multi-line chat door for the WildCat BBS system.  It is
  59.   designed to replace the internal multi-line chat by using a DOS Hook
  60.   from the main menu.
  61.  
  62. Why use it?
  63. ═══════════
  64.  
  65.   WildChat is much faster, and provides many more features than
  66.   WildCat's internal multi-line chat.  WildChat is easier to use,
  67.   and basically, a lot more fun.
  68.  
  69. How does it work?
  70. ═════════════════
  71.  
  72.   WildChat uses the disk to store the messages that users type.  A
  73.   RAM disk is recommended, but not necessary.  A disk cache is
  74.   necessary only if a RAM disk is not used, but still recommended.
  75.  
  76.   WildChat writes to a fixed length file it creates when it is first
  77.   run.  This file is called WILDCHAT.MSG, and it contains the messages
  78.   that users send to each other.  The reason this file is fixed length
  79.   is once again speed.
  80.  
  81.   WildChat writes to another fixed length file called WILDCHAT.DTA. This
  82.   file contains node info data.  This file is used along with WildCat's
  83.   own NODEINFO.DAT to keep track of users on the BBS and in the
  84.   multi-line chat.
  85.  
  86. Other features
  87. ══════════════
  88.  
  89.   Whispering
  90.   ──────────
  91.  
  92.     Whispering is one of those handy features that WildCat's multi-line
  93.     chat just doesn't have.  Normally, messages you type in the multi-
  94.     line chat can be seen by everyone.  WildChat will let you "whisper"
  95.     something to a user privately, so no one else can see your message.
  96.     Let me show you an example.  Let's say there are two users in the
  97.     multi-line chat, T.Rider, and C.North.  You are seeing what T.Rider
  98.     types.
  99.  
  100.       /C.North No one else can see this message!
  101.  
  102.     C.North would see something like this on his screen...
  103.  
  104.       T.Rider (Whispered): No one else can see this message!
  105.  
  106.     It's a handy feature, a must for any conversation!
  107.  
  108.  
  109.   Language Filter
  110.   ───────────────
  111.  
  112.     Naturally, there are always those people who take a liking to words
  113.     that you may not want on your BBS.  If you BBS is a family system,
  114.     then you surely won't want profanity used in the multi-line chat.
  115.     The language filter will screen messages for those words which you
  116.     specify in the file WILDCHAT.BAT.  Read on for more details.
  117.  
  118.   Action Commands
  119.   ───────────────
  120.  
  121.     Action Commands are my favorite feature of WildChat.  Action
  122.     Commands are key-words that are linked to a phrase.  Let me
  123.     show you what action commands do...
  124.  
  125.       Type: LAUGH T.Rider
  126.  
  127.        See: C.North is laughing at T.Rider!
  128.  
  129.     You can do this, and much, much more with the WildChat Action
  130.     Command parser!  Read the section titled "WildChat Files" for more
  131.     details on how to create and edit action commands.
  132.  
  133.   Display Screens
  134.   ───────────────
  135.  
  136.     WildChat uses several external display screens, they are:
  137.  
  138.       CFGHELP.BBS
  139.       MAINHELP.BBS
  140.       HELLO.BBS
  141.       TUTORIAL.BBS
  142.       ALLALONE.BBS
  143.  
  144.     Of course, some example screens have been included, but they aren't
  145.     very good, and I hope to improve them some time.  Feel free to edit
  146.     these screens to your liking.
  147.  
  148.  
  149.  
  150. Files In This Archive
  151. ═════════════════════
  152.  
  153.   Make sure that you have all of these files, and that they are the
  154.   proper file sizes, etc...
  155.  
  156.     ALLALONE BBS       109 12-21-92   2:14p
  157.     CFGHELP  BBS      3783 12-21-92   2:14p
  158.     MAINHELP BBS      3588 12-21-92   2:14p
  159.     WILDCHAT CFG      2461 12-21-92   2:14p
  160.     WILDCHAT DAT     19350 12-21-92   2:14p
  161.     WILDCHAT LST      2610 12-21-92   2:14p
  162.     WILDCHAT EXE     54459 12-21-92   2:14p
  163.     WILDCHAT BAD       299 12-21-92   2:14p
  164.  
  165.  
  166. Installation
  167. ════════════
  168.  
  169.   Make sure ALL nodes are taken down, and that the system is not running
  170.   under a multi-tasker before starting this set up.  Also, ALWAYS BACK
  171.   YOUR SYSTEM UP!
  172.  
  173.  
  174.     1. Make a sub-directory off of the WildCat root directory for WildChat.
  175.        EXAMPLE: C:\WC30\WILDCHAT\
  176.  
  177.        The exact name of the directory doesn't really matter.
  178.  
  179.     2. Move WILDCHAT.EXE, WILDCHAT.DAT, WILDCHAT.BAD, WILDCHAT.LST into
  180.        this directory.
  181.  
  182.        These four files have to be in the same directory, or WildChat
  183.        WILL NOT run.
  184.  
  185.     3. Add a command into your CONFIG.SYS or your AUTOEXEC.BAT to create a
  186.        128k RAM Disk on bootup.
  187.  
  188.        The larger the RAM Disk, the more reliable WildChat should be.
  189.        If you can spare more than 128k for the RAM Disk, make sure to
  190.        increase the "maximum number of messages" field in WILDCHAT.CFG.
  191.  
  192.     4. Edit WILDCHAT.CFG.  Instructions are in the file, and DO NOT remove
  193.        any lines from the file, or your system may suffer a severe disaster.
  194.  
  195.        This is basically what the configuration file looks like.  Make
  196.        sure that there are AT LEAST twenty lines in the file!
  197.  
  198.      D:\
  199.      10
  200.      160
  201.      60
  202.      300
  203.      C:\WC30\WILDCHAT\
  204.      C:\WC30\DATA\
  205.      ON
  206.      50
  207.      CTS/RTS
  208.      ON
  209.      10
  210.      OFF
  211.      ON
  212.      .Don't remove any of these lines
  213.      .Don't remove any of these lines
  214.      .Don't remove any of these lines
  215.      .Don't remove any of these lines
  216.      .Don't remove any of these lines
  217.      .Don't remove any of these lines
  218.  
  219.      ┌─────────────────────────────────────────────────
  220.      │ WildChat! v2.xx Configuration File
  221.      └─────────────────────────────────────────────────
  222.      ┌──────────┬─────────────────────────────────────┬
  223.      │ Line #1  │ RamDrive Path              │
  224.      │ Line #2  │ Maximum Nodes in WILDCHAT.DTA      │
  225.      │ Line #3  │ Maximum Messages in WILDCHAT.MSG      │
  226.      │ Line #4  │ Basic Timeout (Seconds)          │
  227.      │ Line #5  │ Complex TimeOut (Seconds)       │
  228.      │ Line #6  │ Datafiles Path              │
  229.      │ Line #7  │ WildCat! 3.0 Node Info Directory      │
  230.      │ Line #8  │ Foul-Language Filter (ON/OFF)      │
  231.      │ Line #9  │ Percentage of Online Time allowed   │
  232.      │ Line #10 │ Modem Hand-Shaking (NONE, CTS/RTS,  │
  233.      │        │ XON/OFF, BOTH)              │
  234.      │ Line #11 │ Status Line (ON/OFF)          │
  235.      │ Line #12 │ Maximum amount of time that can be  │
  236.      │        │ transferred using the /GIVETIME cmd │
  237.      │        │ (Or OFF to disable /GIVETIME      │
  238.      │ Line #13 │ File Locking (ON/OFF)          │
  239.          │ Line #14 │ File Logging (ON/OFF)               │
  240.          │ Line #15 │ Use FOSSIL (ON/OFF)                 │
  241.  
  242.        Here are some more in-depth notes on the options...
  243.  
  244.        Line #1:  If you are NOT using a RAM Disk, then you can change
  245.          this line to point to a temporary directory, like
  246.          C:\WC30\WCHTFILS, or something like that.  Delete the
  247.          contents of this file every time you completely re-boot
  248.          your BBS system, or if WildChat crashes.
  249.  
  250.        Line #2:  If you have 10 nodes set up in WildCat, specify 10 on
  251.          this line.  If you have 250 nodes, set this to 250...etc...
  252.  
  253.        Line #4:  Basic Timeout is the amount of time you will let users sit
  254.          without pressing a key before logging them off.
  255.  
  256.        Line #5:  Complex Timeout is the amount of time you will let users
  257.          sit without entering a message before logging them off.
  258.  
  259.        Line #6:  Specify the path where you put WILDCHAT.EXE, WILDCHAT.DAT,
  260.          WILDCHAT.BAD, and WILDCHAT.LST on this line.
  261.  
  262.        Line #7:  Specify the path to NODEINFO.DAT on this line.
  263.  
  264.        Line #8:  This line toggles the language filter.
  265.  
  266.        Line #11: Status line toggle.
  267.  
  268.        *******>  If you are using a MONOCHROME monitor, make sure to turn
  269.          the status line off in the configuration file!!
  270.  
  271.        Line #13: If you have a variety of different speed computers on
  272.          your LAN, and strange things are happening like ghost
  273.          messages, etc... Try turning on full file locking.
  274.          Full file locking doesn't agree with some network
  275.          setups, though.
  276.  
  277.        Line #14: If you're WildChat log files are too large, and too
  278.          un-useful for you, you can turn them off with this line.
  279.  
  280.        Line #15: If you have a FOSSIL driver installed, and wish
  281.                  WildChat to use it, then change this line to ON.
  282.  
  283.  
  284.     5. Move the edited WILDCHAT.CFG into the WildCat ROOT directory.
  285.        EXAMPLE: C:\WC30\
  286.  
  287.     6. Find a free Main Menu DOS Hook.
  288.  
  289.     7. Create a batch file to call WildChat.
  290.  
  291.          EXAMPLE    C:\WC30\MAIN1.BAT  (For DOS Hook 1)
  292.  
  293.                     @ECHO OFF
  294.                     C:\WC30\WILDCHAT\WILDCHAT.EXE
  295.  
  296.        NOTE: WildChat -MUST- be run from the WildCat WORK directory.
  297.              Do -NOT- put any CD commands in the batch file, or
  298.              WildChat WILL NOT run.
  299.  
  300.  
  301.     8. If your system uses non-standard IRQ or addresses for COM ports,
  302.        then make sure to add the proper environment variables to the
  303.        correct CATx.BAT file.  Variables needed are listed below...
  304.  
  305.          COMBASE  This is the base address of the COM port being used.
  306.          WCIRQID  This is the IRQ of the COM port being used.
  307.          WCHOME   This is the WildCat home directory.
  308.  
  309.          EXAMPLE  SET COMBASE=1016
  310.                   SET WCIRQID=4
  311.                   SET WCHOME=C:\WC30
  312.  
  313.          NOTE:  COMBASE *MUST* be in decimal.  "03F8" won't work!  You
  314.                 need to use the decimal value, "1016".
  315.  
  316.          NOTE:  WCHOME *MUST NOT* have a trailing back slash.  The
  317.                 trailing back slash will crash TomCat!!
  318.  
  319.      NOTE:    Environment variables *MUST* be EXACLY as shown.
  320.         HOMEPATH will not substitute WCHOME!
  321.  
  322.     9. Use MAKEWILD and do the following...
  323.  
  324.       (a) Change the MAIN MENU "Multi-User Chat" command letter to
  325.           something like "!" or "@", so no one can accidently access
  326.           WildCat's internal chat.
  327.  
  328.       (b) Change the MAIN MENU "Multi-User Chat" command access level
  329.           to 1000, so only the SysOp can access it.
  330.  
  331.  
  332.       (c) Change the MAIN MENU "DOS hook 1" or "DOS hook 2" command
  333.           letter to "T".
  334.  
  335.       (d) Change the MAIN MENU "DOS hook 1" or "DOS hook 2" command
  336.           access level to a level so that users can access it.
  337.  
  338.       (e) Change the MAIN MENU "DOS hook 1" or "DOS hook 2" command
  339.           description to "[T]..Talk with other Node(s)" or something
  340.           like that.
  341.  
  342.       (f) Go to the DOOR DEFINITION area of MAKEWILD, and change the
  343.           "DOS hook 1" or "DOS hook 2" multi-user flag to YES.
  344.  
  345.    10. Use the WCTEXT.DAT editor to change the following prompts...
  346.  
  347.        NOTE: Prompt numbers are for WildCat 3.5 beta.
  348.  
  349.          #252   from @SUB@ is PAGING.
  350.  
  351.        change the above prompts to...
  352.  
  353.          #252   is PAGING you from WildChat.
  354.  
  355.    11. Load one node of WildCat and give WildChat a try in local mode.
  356.        If there's any problem, review the setup for any mistakes, and
  357.        if the problem cannot be resolved, contact me through The Source
  358.        BBS.
  359.  
  360.  
  361. WildChat(tm) Files  <-- MUST, MUST, MUST READ!
  362. ══════════════════
  363.  
  364.   WildChat(tm) uses several data files, this is an explanation of what they
  365.   are and how to maintain them.
  366.  
  367.  
  368.   Files that WildChat(tm) reads
  369.   ─────────────────────────────
  370.  
  371.     WILDCHAT.CFG  The main configuration file
  372.     WILDCHAT.BAD  The words for the language filter
  373.     WILDCHAT.LST  The action commands
  374.     WILDCHAT.DAT  The prompts and text
  375.     CFGHELP.BBS   User Configuration help screen
  376.     MAINHELP.BBS  Main Commands help screen
  377.     ALLALONE.BBS  Display File
  378.     TUTORIAL.BBS  New User Tutorial
  379.     DOOR.SYS      User Info created by WildCat!
  380.  
  381.  
  382.     o WILDCHAT.CFG is a cr/lf format text file.  Use any text editor
  383.       to edit.  If any lines are removed, the door will not run, and
  384.       possible will crash and do unpredictable things.  Please, be
  385.       very careful with this file.  Instructions on which lines are
  386.       which are in the file.
  387.       This is found in the WildCat root directory, which is pointed to
  388.       using the WCHOME environment variable.
  389.  
  390.     o WILDCHAT.BAD is a cr/lf format text file.  Put each word on a
  391.       separate line.  If more than one word is placed on one line, then
  392.       the result may be unpredictable.
  393.       This file is found in the WILDCHAT directory.
  394.  
  395.     o WILDCHAT.LST is a cr/lf format text file.  Each action command
  396.       consists of three lines.  The first line is the key-word for
  397.       the action, which can be up to 15 characters long.  The second
  398.       line is the text that is displayed if the key-word is typed
  399.       alone, without any options.  The third like is the text that is
  400.       displayed when options are typed along with the key-word.
  401.       These following codes can be used in the third line:
  402.  
  403.         @SUB@    This inserts the first word of the options.
  404.         @SUB1@   This insters the second word...
  405.         @SUB2@   ...etc...
  406.         @SUB3@
  407.         @SUB4@
  408.         @SUB5@
  409.         @SUB6@
  410.         @SUB7@
  411.         @SUB8@
  412.  
  413.         @SUBA@   This inserts the whole of the options typed.
  414.         @SUBB@   This inserts the options typed from the second word on.
  415.         @SUBC@   This inserts the complete command typed, including the
  416.                  key-word of the action command.
  417.  
  418.       See WILDCHAT.LST for more examples.  Some where around 30 to 40
  419.       are included now.
  420.  
  421.       This file is found in the WILDCHAT directory.
  422.  
  423.     o WILDCHAT.DAT is the file containing the text that WildChat(tm)
  424.       outputs.  This is the same format as WCTEXT.DAT, and can be edited
  425.       with the WCTEXT.DAT editor that is included with WildCat!  Make
  426.       sure to make a backup before altering this file.
  427.       This file is found in the WILDCHAT directory.
  428.  
  429.  
  430.     o CFGHELP.BBS is a help screen in WildCat 3.0 format.  You can use
  431.       @CLS@, @PAUSE@, and @xx@ color commands.
  432.  
  433.     o MAINHELP.BBS is a help screen in WildCat 3.0 format.  You can use
  434.       @CLS@, @PAUSE@, and @xx@ color commands.
  435.  
  436.     o ALLALONE.BBS is displayed when a user enters the door, and there
  437.       is no one else to chat with.
  438.  
  439.     o TUTORIAL.BBS is displayed to new users if they want to see it.
  440.  
  441.     o DOOR.SYS... read the WildCat! manual.
  442.  
  443.   Files that WildChat(tm) creates
  444.   ───────────────────────────────
  445.  
  446.     WILDCHAT.DTA  Contains node information (Who's Online, etc)*
  447.     WILDCHAT.MSG  Contains messages that users type*
  448.     WILDCHAT.USR  Contains user profiles and configuration
  449.     WILDLOG!.???  Contains logging information.  Where ??? is the node #.
  450.  
  451.       * denotes that file is a fixed size
  452.  
  453.     o WILDCHAT.DTA contains information about who is inside WildChat(tm).
  454.       This file should be deleted on every boot-up (if not on a ram disk)
  455.       or any time that WILDCHAT.CFG changes.
  456.       This file is on the RAMDISK.
  457.  
  458. ----> MAKE SURE ALL NODES ARE DOWN BEFORE DELETING OR EDITING ANY
  459.       WILDCHAT(tm) FILES!
  460.  
  461. ----> IF YOU ARE GETTING A "NODE HANDLE IN USE" ERRORS THEN YOU MUST
  462. ----> DELETE WILDCHAT.DTA AND WILDCHAT.MSG.
  463.  
  464.     o WILDCHAT.MSG contains the messages that the users type
  465.       to each other.  This should be treated EXACTLY the way
  466.       WILDCHAT.DTA is treated.
  467.       This file is on the RAMDISK.
  468.  
  469.     o WILDCHAT.USR contains user information and configuration.  This
  470.       file can be deleted, but then users will have to log on new again,
  471.       which is not much of a hassle.  (It may only confuse some users)
  472.       This file is found in the WILDCHAT directory.
  473.  
  474.     o WILDLOG!.??? contains logging information for each node.
  475.       This file should be deleted whenever it gets too large.
  476.       These files are found in the WILDCHAT directory.
  477.  
  478.  
  479. Special Thanks
  480. ══════════════
  481.  
  482.   I'd like to thank the following people for making WildChat possible...
  483.  
  484.     Michael Conley, thanks for all the suggestions, you were a big help!
  485.  
  486.     Tom Tcimpidis, thanks for picking out all the minute details!
  487.  
  488.     Chip North, thanks for running The Source, and for helping me test
  489.                 this thing!  Also, Thanks for letting me borrow your
  490.                 USR World Port 9600!  I'd be lost without it!
  491.  
  492.     Jeff Sumberg, who wrote QBSerial, the serial communications
  493.                   interface used in WildChat(tm).  Thanks Jeff!  You
  494.                   wrote some GREAT routines!
  495.  
  496.     Lance Stewart, beta tester.
  497.     Hugh Mitchell, beta tester.
  498.     Clayton Manson, beta tester.
  499.  
  500.     Dan Stasinski, honorable mention.  Good guy, great programmer, but
  501.                    I still can't spell his name right.
  502.  
  503.  
  504.